home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cat3 / Vk / VkCompletionField.z / VkCompletionField
Encoding:
Text File  |  1998-10-20  |  8.3 KB  |  199 lines
  1.  
  2.  
  3.  
  4. VVVVkkkkCCCCoooommmmpppplllleeeettttiiiioooonnnnFFFFiiiieeeelllldddd((((3333xxxx))))                                    VVVVkkkkCCCCoooommmmpppplllleeeettttiiiioooonnnnFFFFiiiieeeelllldddd((((3333xxxx))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      VkCompletionField - A text input field that supports automatic name
  10.      completion
  11.  
  12. IIIINNNNHHHHEEEERRRRIIIITTTTSSSS FFFFRRRROOOOMMMM
  13.      VkComponent : VkCallbackObject
  14.  
  15. HHHHEEEEAAAADDDDEEEERRRR FFFFIIIILLLLEEEE
  16.      #include <Vk/VkCompletionField.h>
  17.  
  18. PPPPUUUUBBBBLLLLIIIICCCC PPPPRRRROOOOTTTTOOOOCCCCOOOOLLLL SSSSUUUUMMMMMMMMAAAARRRRYYYY
  19.    CCCCoooonnnnssssttttrrrruuuuccccttttoooorrrr////DDDDeeeessssttttrrrruuuuccccttttoooorrrr
  20.           VkCompletionField(const char* name, Widget parent);
  21.           virtual void ~VkCompletionField(void);
  22.  
  23.  
  24.    CCCCoooonnnnttttrrrroooolllllllliiiinnnngggg CCCCuuuurrrrrrrreeeennnntttt CCCCoooommmmpppplllleeeettttiiiioooonnnnssss
  25.           void add(char* name);
  26.           void clear(void);
  27.  
  28.  
  29.    AAAAcccccccceeeessssssss ttttoooo tttteeeexxxxtttt
  30.           char *getText();
  31.  
  32.  
  33. PPPPRRRROOOOTTTTEEEECCCCTTTTEEEEDDDD PPPPRRRROOOOTTTTOOOOCCCCOOOOLLLL SSSSUUUUMMMMMMMMAAAARRRRYYYY
  34.    MMMMaaaannnniiiippppuuuullllaaaattttiiiinnnngggg PPPPaaaarrrrttttiiiiaaaallll EEEExxxxppppaaaannnnssssiiiioooonnnnssss
  35.           virtual void expand(struct XmTextVerifyCallbackStruct* cb);
  36.  
  37.  
  38.    AAAAcccccccceeeessssssss ttttoooo CCCCuuuurrrrrrrreeeennnntttt EEEExxxxppppaaaannnnssssiiiioooonnnnssss
  39.           virtual void activate(struct XmTextVerifyCallbackStruct* cb);
  40.           VkNameList* _currentMatchList;
  41.           VkNameList* _nameList;
  42.  
  43.  
  44. CCCCLLLLAAAASSSSSSSS DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  45.           The VkCompletionField component is a text input field that supports
  46.           name expansion. If the user types a space, the component attempts to
  47.           complete the current contents of the text field, based on a known
  48.           list of possible expansions. Applications must provide the list of
  49.           possible expansions.  Applications that wish to be notified when the
  50.           user types a <RETURN> into the text field can register a ViewKit
  51.           C++-style callback using the _V_k_C_o_m_p_l_e_t_i_o_n_F_i_l_e_d::_e_n_t_e_r_C_a_l_l_b_a_c_k()
  52.           hook.
  53.  
  54.  
  55.  
  56. DDDDEEEERRRRIIIIVVVVIIIINNNNGGGG SSSSUUUUBBBBCCCCLLLLAAAASSSSSSSSEEEESSSS
  57.           Applications that wish to have more control over the expansion
  58.           process might benefit from subclassing. The _e_x_p_a_n_d() member
  59.           function, which is called when the user types into the text field,
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. VVVVkkkkCCCCoooommmmpppplllleeeettttiiiioooonnnnFFFFiiiieeeelllldddd((((3333xxxx))))                                    VVVVkkkkCCCCoooommmmpppplllleeeettttiiiioooonnnnFFFFiiiieeeelllldddd((((3333xxxx))))
  71.  
  72.  
  73.  
  74.           can be overridden, and derived classes can also access the complete
  75.           list of possible completions as well as those items that match the
  76.           current list of partial matches.  Derived classes that wish to be
  77.           notified when the user types a <RETURN> into the text field can
  78.           override the _a_c_t_i_v_a_t_e() member function.
  79.  
  80.  
  81.  
  82. FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNNSSSS
  83.    aaaaccccttttiiiivvvvaaaatttteeee(((())))
  84.           virtual void activate(struct XmTextVerifyCallbackStruct* cb);
  85.  
  86.  
  87.           Called when the user types a <RETURN> key. The component attempts to
  88.           expand the current content of the text field before this function is
  89.           called.
  90.  
  91.    eeeexxxxppppaaaannnndddd(((())))
  92.           virtual void expand(struct XmTextVerifyCallbackStruct* cb);
  93.  
  94.  
  95.           Called when any text is typed into the text field.
  96.  
  97.    VVVVkkkkCCCCoooommmmpppplllleeeettttiiiioooonnnnFFFFiiiieeeelllldddd(((())))
  98.           VkCompletionField(const char* name, Widget parent);
  99.  
  100.  
  101.           Initializes the VkCompletionField class and creates the widgets used
  102.           by the component.
  103.  
  104.    ~~~~VVVVkkkkCCCCoooommmmpppplllleeeettttiiiioooonnnnFFFFiiiieeeelllldddd(((())))
  105.           virtual void ~VkCompletionField(void);
  106.  
  107.  
  108.           Frees all storage associated with this class.
  109.  
  110.    aaaadddddddd(((())))
  111.           void add(char* name);
  112.  
  113.  
  114.           Add an item to the list of possible expansions.
  115.  
  116.    cccclllleeeeaaaarrrr(((())))
  117.           void clear(void);
  118.  
  119.  
  120.           Clear all possible expansions.
  121.  
  122. DDDDAAAATTTTAAAA MMMMEEEEMMMMBBBBEEEERRRR DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNNSSSS
  123.    ____ccccuuuurrrrrrrreeeennnnttttMMMMaaaattttcccchhhhLLLLiiiisssstttt
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. VVVVkkkkCCCCoooommmmpppplllleeeettttiiiioooonnnnFFFFiiiieeeelllldddd((((3333xxxx))))                                    VVVVkkkkCCCCoooommmmpppplllleeeettttiiiioooonnnnFFFFiiiieeeelllldddd((((3333xxxx))))
  137.  
  138.  
  139.  
  140.           VkNameList* _currentMatchList;
  141.  
  142.  
  143.           At any point following an expansion, this list contains all possible
  144.           expansions of the current text.
  145.  
  146.    ____nnnnaaaammmmeeeeLLLLiiiisssstttt
  147.           VkNameList* _nameList;
  148.  
  149.  
  150.           This list contains all possible expansions registered with the
  151.           component.
  152.  
  153. IIIINNNNHHHHEEEERRRRIIIITTTTEEEEDDDD MMMMEEEEMMMMBBBBEEEERRRR FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNNSSSS
  154.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm VVVVkkkkCCCCoooommmmppppoooonnnneeeennnntttt
  155.           installDestroyHandler(), removeDestroyHandler(), widgetDestroyed(),
  156.           afterRealizeHook(), setDefaultResources(), getResources(), show(),
  157.           hide(), realize(), manage(), unmanage(), name(), baseWidget()
  158.           okToQuit(), _name, _baseWidget, _w, deleteCallback
  159.  
  160.  
  161.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm VVVVkkkkCCCCaaaallllllllbbbbaaaacccckkkkOOOObbbbjjjjeeeecccctttt
  162.           callCallbacks(), addCallback(), removeCallback(),
  163.           removeAllCallbacks()
  164.  
  165.  
  166. CCCCLLLLAAAASSSSSSSSEEEESSSS UUUUSSSSEEEEDDDD BBBBYYYY TTTTHHHHIIIISSSS CCCCLLLLAAAASSSSSSSS
  167.      VkNameList
  168.  
  169. BBBBUUUUGGGGSSSS
  170. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  171.      VkComponent, VkNameList _V_i_e_w_K_i_t _P_r_o_g_r_a_m_m_e_r'_s _G_u_i_d_e
  172.      _T_h_e _X _W_i_n_d_o_w _S_y_s_t_e_m, DEC Press, Bob Sheifler and Jim Gettys
  173.      _T_h_e _X _W_i_n_d_o_w _S_y_s_t_e_m _T_o_o_l_k_i_t, DEC Press, Paul Asente and Ralph Swick
  174.      _T_h_e _O_S_F/_M_o_t_i_f _P_r_o_g_r_a_m_m_e_r_s _R_e_f_e_r_e_n_c_e, Prentice Hall, OSF
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.